home *** CD-ROM | disk | FTP | other *** search
/ Clickx 115 / Clickx 115.iso / software / tools / windows / tails-i386-0.16.iso / live / filesystem.squashfs / usr / share / doc / python-sip / README < prev   
Encoding:
Text File  |  2010-01-29  |  1.1 KB  |  31 lines
  1. SIP - C/C++ Bindings Generator for Python v2 and v3
  2. ===================================================
  3.  
  4. The SIP documentation (including installation instructions) can be found in the
  5. ``doc`` directory.
  6.  
  7.  
  8. Building from the Mercurial Repository
  9. --------------------------------------
  10.  
  11. If you are using a copy of SIP cloned from the Mercurial repository, or are
  12. using a Mercurial archive, then you have to prepare it first before you follow
  13. the normal installation instructions.
  14.  
  15. The preparation is done using the ``build.py`` script which can be found in the
  16. same directory as this ``README`` file.  If it isn't there then you probably
  17. have a packaged release and should just follow the normal installation
  18. instructions.
  19.  
  20. The ``build.py`` script requires that ``flex`` and ``bison`` are installed.  If
  21. you want to create the HTML documentation then Sphinx must also be installed.
  22.  
  23. To prepare run the following::
  24.  
  25.     python build.py prepare
  26.  
  27. Now you can follow the normal installation instructions.
  28.  
  29. The ``build.py`` script has other useful commands, use the ``--help`` option to
  30. see the details.
  31.